docs: improve documentation accuracy and add missing reference docs #51
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Reorder executors.md to recommend SubprocessExecutor first with decision guide - Update all examples from InProcessExecutor to SubprocessExecutor - Replace internal storage.get_*() calls with Session facade APIs - Fix outdated tools.call() syntax in minimal example - Add warnings to InProcessExecutor section about risks - Add branch policy to AGENTS.md (main is protected) Files updated: - README.md, docs/getting-started.md, docs/executors.md - docs/dependencies.md, docs/production.md, docs/skills.md - docs/storage.md, docs/ARCHITECTURE.md - examples/minimal/README.md, AGENTS.md
New documentation: - docs/cli-reference.md: MCP server flags and Store CLI commands - docs/session-api.md: Complete Session method reference - docs/integrations.md: Framework integration patterns Updated: - README.md: Reorganized documentation links, added new docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
New Documentation
docs/cli-reference.md- MCP server flags and Store CLI commandsdocs/session-api.md- Complete Session method referencedocs/integrations.md- Framework integration patternsUpdated Documentation
docs/executors.md- Reordered to recommend SubprocessExecutor, added decision guidedocs/getting-started.md- Changed examples to use SubprocessExecutordocs/dependencies.md- Fixed outdatedstorage.get_deps_store()referencesdocs/production.md- Fixed internal API usagedocs/skills.md- Use Session facade instead of internal storesdocs/storage.md- Updated migration section, fixed executor exampledocs/ARCHITECTURE.md- Added quick reference, updated decision treeexamples/minimal/README.md- Fixed outdatedtools.call()syntaxREADME Improvements
Meta